Telerik Private NuGet Source

This article explains how to add the private Telerik NuGet package feed to your environment. You can use it to obtain the Telerik UI for Blazor components instead of setting up a local NuGet feed.

The benefit of using an online NuGet source is that you will receive notifications for newer component versions.

You can set up the remote Telerik NuGet feed in the following ways:

• Use Visual Studio
• Use the .NET CLI
• Edit the Nuget.Config file

When working with the .NET CLI or editing the NuGet.Config manually, you can use your Telerik account credentials or a NuGet API Key. If you are logging in to telerik.com through single sign-on (SSO), use a NuGet API Key.

Never hard-code Telerik account credentials or NuGet API keys in a NuGet.Config file in a GitHub repository, Docker image, or any location that may be accessed by unauthorized parties. A NuGet key is valuable and bad actors can use it to access the NuGet packages that are licensed under your account. A credentials abuse can lead to a review of the affected Telerik account.

For NuGet-related issues, see NuGet Feed Troubleshooting.

For information on automated builds, CI and CD, see CI, CD, Build Server.

Use Visual Studio

When adding NuGet sources in Visual Studio, the credentials are encrypted and stored outside the NuGet.Config file.

Refer to the Microsoft documentation about using packages in Visual Studio, or follow the steps below for Visual Studio on Windows.

1. Open Visual Studio and go to Tools > NuGet Package Manager > Package Manager Settings > Package Sources.

2. Click the + button at the top right-hand side.

3. Add the Telerik Feed URL https://nuget.telerik.com/v3/index.json and choose a Name for that package source (for example, "TelerikOnlineFeed").

4. Click OK.

5. Open a project that references a Telerik NuGet package. For example, generate one through our New Project Wizard.

   • Make sure to remove local NuGet.Config files from the solution that contain information about Telerik packages.

6. Rebuild the solution.

7. A Windows prompt will ask for the Telerik feed credentials. Enter your Telerik email and password.

   • Check the Remember My Password checkbox.

8. Your project should now build and restore all packages - including those from nuget.org and from Telerik.

   • If you experience issues, see the NuGet Feed Troubleshooting article.

Use the .NET CLI

When adding NuGet sources from the .NET CLI, the credentials are stored in the NuGet.Config file. The password can be encrypted on Windows, but with limitations. You can use a plain text password, but for better security, generate a NuGet API Key, and use it with the .NET CLI instead of a password.

To add the Telerik NuGet package source with the .NET CLI, use the dotnet nuget add source command. This command creates or updates a NuGet.Config file for you, so you don't have to edit it manually.

The command below stores the password or NuGet API Key in plain text in the global config file.

The backslashes \ below enable multi-line commands for better readability in terminals that support them.

Use the .NET CLI to add the Telerik NuGet source

dotnet nuget add source https://nuget.telerik.com/v3/index.json \
--name TelerikOnlineFeed \
--username <TELERIK EMAIL or api-key> \
--password <TELERIK PASSWORD or NUGET API KEY> \
--store-password-in-clear-text

If you have already stored the Telerik package source, you can update the configuration with the command below.

Use the .NET CLI to update the Telerik NuGet source

dotnet nuget update source "TelerikOnlineFeed" \
--source "https://nuget.telerik.com/v3/index.json" \
--username <TELERIK EMAIL or api-key> \
--password <TELERIK PASSWORD or NUGET API KEY> \
--store-password-in-clear-text

Store Encrypted Credentials

The .NET CLI supports NuGet password encryption only on the Windows platform. Note that the encrypted password in the NuGet.Config file will work only for one user and one machine.

If you add the Telerik package source in Visual Studio, the credentials will be encrypted and stored in the Windows Credential Manager on Windows and in the Keychain on macOS.

You can read more about the options provided by the NuGet tooling in the packageSourceCredentials section of the NuGet.Config reference article by Microsoft. Note the difference between the password and cleartextpassword options.

Edit the NuGet.Config File

NuGet package sources and other settings are stored in a NuGet.Config file. You can read more about the file structure in the Microsoft article NuGet.Config Reference.

Make sure you are familiar with how such configurations work. Refer to Common NuGet Configurations for details about the possible file locations and how multiple NuGet.Config files work.

To edit a NuGet.Config file and add the Telerik feed, you need to:

1. Ensure you are editing the correct and desired config file. You can also create a new one with the dotnet new nugetconfig command.

2. Add the Telerik package source to the config file. Use plain text credentials, because the .NET Core NuGet tooling does not fully support encrypted credentials. Here is an example of how your NuGet.Config file can look like:

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
       <packageSources>
       <!--To inherit the global NuGet package sources remove the <clear/> line below -->
       <clear />
       <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
       <add key="TelerikOnlineFeed" value="https://nuget.telerik.com/v3/index.json" />
       </packageSources>
       <packageSourceCredentials>
       <TelerikOnlineFeed>
           <add key="Username" value="<TELERIK EMAIL or api-key>" />
           <add key="ClearTextPassword" value="<TELERIK PASSWORD or NUGET API KEY>" />
       </TelerikOnlineFeed>
       </packageSourceCredentials>
   </configuration>
   

Use NuGet API Key

There are two ways to authenticate with the Telerik NuGet server when you add the Telerik NuGet source with the .NET CLI or edit the NuGet.Config file manually:

• Use your Telerik account email as the username, and your Telerik password.
• Use api-key as the username and your personal NuGet API Key as the password.

You can generate your Telerik NuGet API Key on telerik.com. Read more about using NuGet API Keys in different environments.

Always use the NuGet API Key in plain text.

Package Source Mapping

The Telerik.UI.for.Blazor NuGet package and most of its dependencies reside on nuget.telerik.com. On the other hand, the Telerik icon packages reside on nuget.org. The correct package source mapping configuration should be similar to:

Make sure that the key values in the packageSourceMapping section match the key values in the packageSources section, otherwise you will get a "Package not found" error.

packageSourceMapping configuration for Telerik UI for Blazor and other Telerik Packages

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <packageSources>      
        <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
        <add key="TelerikOnlineFeed" value="https://nuget.telerik.com/v3/index.json" />
    </packageSources>

    <packageSourceMapping>
        <packageSource key="nuget.org">
            <package pattern="*" />
            <package pattern="Telerik.FontIcons" />
            <package pattern="Telerik.SvgIcons" />
        </packageSource>
        <packageSource key="TelerikOnlineFeed">
            <package pattern="Telerik*" />
            <package pattern="Kendo*" />
            <package pattern="UI.for*" />
            <package pattern="JustMock*" />
        </packageSource>
    </packageSourceMapping>
</configuration>

Access NuGet Packages behind Firewall

To access the Telerik NuGet feed behind a firewall that restricts outgoing requests, you may need to allow the following domains:

• nuget.telerik.com, which provides authentication and license verification
• downloads.cdn.telerik.com, which hosts the NuGet packages

The firewall must allow some of the requests to be redirected from nuget.telerik.com to downloads.cdn.telerik.com.

Obsolete Telerik NuGet URL

In addition to feed URL https://nuget.telerik.com/v3/index.json, there is also an obsolete NuGet v2 server at https://nuget.telerik.com/nuget, which is no longer recommended.

The NuGet v2 server at https://nuget.telerik.com/nuget will be sunset in November 2024.

The new v3 protocol offers faster package searches and restores, improved security, and more reliable infrastructure.

To redirect your feed to the NuGet v3 protocol, all you have to do is to change your NuGet package source URL to https://nuget.telerik.com/v3/index.json.

Troubleshooting

See the NuGet Troubleshooting article for tips about common pitfalls when working with the Telerik NuGet feed.

Next Steps

Once you have the Telerik NuGet source set up, follow the instructions to create a Telerik Blazor app.

Further Reading

You may find useful the following Microsoft articles on securing your NuGet feed setup and supply chain as general best practices:

• Lock down your dependencies using configurable trust policies - Blog Post

• How to Scan NuGet Packages for Security Vulnerabilities - Blog Post

• Best practices for a secure software supply chain - MSDN docs

Telerik provides signed NuGet packages that you can verify.

See Also

• NuGet Feed Troubleshooting
• CI, CD, Build Server